/*
 *  Copyright 2019-2020 Zheng Jie
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *  http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 */
package me.zhengjie.aspect;

import com.google.common.collect.ImmutableList;
import me.zhengjie.annotation.Limit;
import me.zhengjie.exception.BadRequestException;
import me.zhengjie.utils.RequestHolder;
import me.zhengjie.utils.StringUtils;
import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.aspectj.lang.reflect.MethodSignature;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.script.DefaultRedisScript;
import org.springframework.data.redis.core.script.RedisScript;
import org.springframework.stereotype.Component;
import javax.servlet.http.HttpServletRequest;
import java.lang.reflect.Method;

/**
 * @author /
 * Spring AOP 和 Redis 实现的接口限流切面，用于防止接口被频繁调用导致系统过载。
 * 它通过 @Limit 注解来标识需要进行限流控制的方法。
 *
 * 核心组件和依赖
 * 1、RedisTemplate: 用于与 Redis 进行交互
 * 2、Lua 脚本: 保证限流操作的原子性
 * 3、Guava 的 ImmutableList: 创建不可变的键列表
 * 4、RequestHolder: 获取当前 HTTP 请求上下文
 *
 * 限流原理
 * 基于 Redis 计数器: 使用 Redis 的 INCR 命令实现计数
 * 原子性操作: 通过 Lua 脚本保证整个限流过程的原子性
 * 自动过期: 首次访问时设置过期时间，避免内存泄漏
 * 灵活的限流维度: 支持基于 IP 或方法名的限流
 */
@Aspect
@Component
public class LimitAspect {

    private final RedisTemplate<Object,Object> redisTemplate;
    private static final Logger logger = LoggerFactory.getLogger(LimitAspect.class);

    public LimitAspect(RedisTemplate<Object,Object> redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    // 切点-匹配所有带有 @Limit 注解的方法
    @Pointcut("@annotation(me.zhengjie.annotation.Limit)")
    public void pointcut() {
    }

    // 通知-实现具体的限流逻辑
    // 1、获取当前请求和方法签名信息
    //2、解析 @Limit 注解参数
    //3、构造 Redis 键名
    //4、执行 Lua 脚本进行限流判断
    //5、根据结果决定是否允许执行目标方法
    @Around("pointcut()")
    public Object around(ProceedingJoinPoint joinPoint) throws Throwable {
        //获取 HTTP 请求对象
        HttpServletRequest request = RequestHolder.getHttpServletRequest();
        MethodSignature signature = (MethodSignature) joinPoint.getSignature();
        Method signatureMethod = signature.getMethod();
        //通过反射获取方法上的 @Limit 注解信息
        Limit limit = signatureMethod.getAnnotation(Limit.class);
        LimitType limitType = limit.limitType();
        String key = limit.key();
        if (StringUtils.isEmpty(key)) {
            //根据限流类型确定键名（IP地址或方法名）
            if (limitType == LimitType.IP) {
                key = StringUtils.getIp(request);
            } else {
                key = signatureMethod.getName();
            }
        }

        //构造完整的 Redis 键名
        ImmutableList<Object> keys = ImmutableList.of(StringUtils.join(limit.prefix(), "_", key, "_", request.getRequestURI().replace("/","_")));

        //执行 Lua 脚本进行原子性限流操作
        String luaScript = buildLuaScript();
        RedisScript<Number> redisScript = new DefaultRedisScript<>(luaScript, Number.class);
        Number count = redisTemplate.execute(redisScript, keys, limit.count(), limit.period());
        //判断访问次数是否超过限制，决定是否放行
        if (null != count && count.intValue() <= limit.count()) {
            logger.info("第{}次访问key为 {}，描述为 [{}] 的接口", count, keys, limit.name());
            return joinPoint.proceed();
        } else {
            throw new BadRequestException("访问次数受限制");
        }
    }

    /**
     * 限流脚本
     *   local c
     *   c = redis.call('get',KEYS[1])           -- 获取当前计数
     *   if c and tonumber(c) > tonumber(ARGV[1]) then  -- 判断是否超过限制
     *       return c;                           -- 超过限制，直接返回
     *   end
     *   c = redis.call('incr',KEYS[1])          -- 增加计数
     *   if tonumber(c) == 1 then                -- 如果是第一次访问
     *       redis.call('expire',KEYS[1],ARGV[2]) -- 设置过期时间
     *   end
     *   return c;                               -- 返回当前计数
     *
     */
    private String buildLuaScript() {
        return "local c" +
                "\nc = redis.call('get',KEYS[1])" +
                "\nif c and tonumber(c) > tonumber(ARGV[1]) then" +
                "\nreturn c;" +
                "\nend" +
                "\nc = redis.call('incr',KEYS[1])" +
                "\nif tonumber(c) == 1 then" +
                "\nredis.call('expire',KEYS[1],ARGV[2])" +
                "\nend" +
                "\nreturn c;";
    }
}
